Skip to main content

Re-Assign Delivery Order

PUT /tms/delivery-orders/{deliveryOrderUuid}/re-assign

Description​

This endpoint is used to re-assign a delivery order to a different driver. The operation requires the delivery order UUID, user ID, and driver ID.

Parameters​

  • countryCode (string, header, required): The country code.
  • tenantId (string, header, required): The tenant ID.
  • deliveryOrderUuid (string, path, required): The UUID of the delivery order to be re-assigned.

Request Body​

  • Media Type: application/json

Example Value​

{
  "userId": "string",
  "driverId": "string"
}

Success Response (200)​

The Success Response (200) is returned when the delivery order is successfully re-assigned. This response indicates the success of the operation and provides additional details.

Response Fields​

FieldTypeDescription
statusbooleanIndicates the success of the re-assign request.
statusCodeintegerNumeric code representing the status of the response (e.g., 0 for success).
messagestringA message indicating the outcome of the operation.
dataobjectContains the updated delivery order details.
errorsarrayAn array of objects providing details about any errors encountered during the request.

Example​

{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Media Type​

application/json: The response is in JSON format.

Example Value​

Schema:

{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Error Responses​

400 - Invalid Reference Supplied

The Invalid Reference Supplied (400) response indicates that the provided reference was invalid.​

404 - Resource Not Found

The Resource Not Found (404) response indicates that the specified resource could not be found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request PUT \ 
 --url  /tms/delivery-orders/{deliveryOrderUuid}/re-assign \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!